<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Image Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">Image Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Displays an image within the report.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Image</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>image</code></td></tr>
<tr><td>Extends:</td>
<td><a href="ReportItem.html">ReportItem</a></td></tr>
<tr><td>Extendable:</td>
<td>Yes</td></tr>
<tr><td>Abstract:</td>
<td>No</td></tr>
<tr><td>Name Space:</td>
<td>Report Items</td></tr>
<tr><td>Name Requirement:</td>
<td>Optional</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>Yes</td></tr>
<tr><td>Default Style:</td>
<td><a href="../styles.html#image">image</a></td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-action">action</a></dt>
<dd>An optional hyperlink for this image.</dd>
<dt><a href="#Property-altText">altText</a></dt>
<dd>An optional text message to display in place of the image in a web browser.</dd>
<dt><a href="#Property-altTextID">altTextID</a></dt>
<dd>Resource key for the altText property.</dd>
<dt><a href="#Property-fitToContainer">fitToContainer</a></dt>
<dd></dd>
<dt><a href="#Property-helpText">helpText</a></dt>
<dd>An optional help text for the image.</dd>
<dt><a href="#Property-helpTextID">helpTextID</a></dt>
<dd></dd>
<dt><a href="#Property-imageName">imageName</a></dt>
<dd>The name of an embedded image if the Source type is Embedded.</dd>
<dt><a href="#Property-scale">scale</a></dt>
<dd></dd>
<dt><a href="#Property-size">size</a></dt>
<dd>How to manage the relationship between image and item 
size.</dd>
<dt><a href="#Property-source">source</a></dt>
<dd>The kind of image reference.</dd>
<dt><a href="#Property-typeExpr">typeExpr</a></dt>
<dd>An expression that returns the type of the image expressed as a MIME type.</dd>
<dt><a href="#Property-uri">uri</a></dt>
<dd>The identifier for the image if the type is File or URL.</dd>
<dt><a href="#Property-valueExpr">valueExpr</a></dt>
<dd>An expression which returns the image contents.</dd>
</dl>

<h3>Method Summary</h3>

<dl class="section-text">
<dt><a href="#Method-onCreate">onCreate</a></dt>
<dd>Script executed when the element is created in the Factory.</dd>
<dt><a href="#Method-onPageBreak">onPageBreak</a></dt>
<dd></dd>
<dt><a href="#Method-onPrepare">onPrepare</a></dt>
<dd>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</dd>
<dt><a href="#Method-onRender">onRender</a></dt>
<dd>Script executed when the element is prepared for rendering in the Presentation engine.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportItem.html#Property-ACLExpression">ACLExpression</a>, 
<a href="ReportItem.html#Property-allowExport">allowExport</a>, 
<a href="ReportItem.html#Property-bookmark">bookmark</a>, 
<a href="ReportItem.html#Property-bookmarkDisplayName">bookmarkDisplayName</a>, 
<a href="ReportItem.html#Property-boundDataColumns">boundDataColumns</a>, 
<a href="ReportItem.html#Property-cascadeACL">cascadeACL</a>, 
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="ReportItem.html#Property-cube">cube</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportItem.html#Property-dataBindingRef">dataBindingRef</a>, 
<a href="ReportItem.html#Property-dataSet">dataSet</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="ReportItem.html#Property-height">height</a>, 
<a href="ReportItem.html#Property-multiViews">multiViews</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="ReportItem.html#Property-paramBindings">paramBindings</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="ReportItem.html#Property-pushDown">pushDown</a>, 
<a href="ReportItem.html#Property-refTemplateParameter">refTemplateParameter</a>, 
<a href="ReportItem.html#Property-style">style</a>, 
<a href="ReportItem.html#Property-toc">toc</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>, 
<a href="ReportItem.html#Property-visibility">visibility</a>, 
<a href="ReportItem.html#Property-width">width</a>, 
<a href="ReportItem.html#Property-x">x</a>, 
<a href="ReportItem.html#Property-y">y</a>, 
<a href="ReportItem.html#Property-zIndex">zIndex</a>
</p>
<h3>Inherited Property Notes</h3>

<dl class="section-text">
<dt><a href="ReportItem.html#Property-dataSet">dataSet</a></dt>
<dd>Allows the user to fetch the image from a data set. 
The image is in the first row of the data set.</dd>
<dt><a href="ReportItem.html#Property-toc">toc</a></dt>
<dd>While the image can appear in the TOC, it is 
generally not very useful to do so.</dd>
</dl>

<h3>Style Properties</h3>

<p class="section-text">
<a href="Style.html#Property-backgroundColor">backgroundColor</a>, 
<a href="Style.html#Property-borderBottomColor">borderBottomColor</a>, 
<a href="Style.html#Property-borderBottomStyle">borderBottomStyle</a>, 
<a href="Style.html#Property-borderBottomWidth">borderBottomWidth</a>, 
<a href="Style.html#Property-borderLeftColor">borderLeftColor</a>, 
<a href="Style.html#Property-borderLeftStyle">borderLeftStyle</a>, 
<a href="Style.html#Property-borderLeftWidth">borderLeftWidth</a>, 
<a href="Style.html#Property-borderRightColor">borderRightColor</a>, 
<a href="Style.html#Property-borderRightStyle">borderRightStyle</a>, 
<a href="Style.html#Property-borderRightWidth">borderRightWidth</a>, 
<a href="Style.html#Property-borderTopColor">borderTopColor</a>, 
<a href="Style.html#Property-borderTopStyle">borderTopStyle</a>, 
<a href="Style.html#Property-borderTopWidth">borderTopWidth</a>, 
<a href="Style.html#Property-color">color</a>, 
<a href="Style.html#Property-display">display</a>, 
<a href="Style.html#Property-fontFamily">fontFamily</a>, 
<a href="Style.html#Property-fontSize">fontSize</a>, 
<a href="Style.html#Property-fontStyle">fontStyle</a>, 
<a href="Style.html#Property-fontVariant">fontVariant</a>, 
<a href="Style.html#Property-fontWeight">fontWeight</a>, 
<a href="Style.html#Property-highlightRules">highlightRules</a>, 
<a href="Style.html#Property-marginBottom">marginBottom</a>, 
<a href="Style.html#Property-marginLeft">marginLeft</a>, 
<a href="Style.html#Property-marginRight">marginRight</a>, 
<a href="Style.html#Property-marginTop">marginTop</a>, 
<a href="Style.html#Property-masterPage">masterPage</a>, 
<a href="Style.html#Property-paddingBottom">paddingBottom</a>, 
<a href="Style.html#Property-paddingLeft">paddingLeft</a>, 
<a href="Style.html#Property-paddingRight">paddingRight</a>, 
<a href="Style.html#Property-paddingTop">paddingTop</a>, 
<a href="Style.html#Property-pageBreakAfter">pageBreakAfter</a>, 
<a href="Style.html#Property-pageBreakBefore">pageBreakBefore</a>, 
<a href="Style.html#Property-pageBreakInside">pageBreakInside</a>, 
<a href="Style.html#Property-showIfBlank">showIfBlank</a>, 
<a href="Style.html#Property-textAlign">textAlign</a>, 
<a href="Style.html#Property-textLineThrough">textLineThrough</a>, 
<a href="Style.html#Property-textOverline">textOverline</a>, 
<a href="Style.html#Property-textUnderline">textUnderline</a>, 
<a href="Style.html#Property-verticalAlign">verticalAlign</a>
</p>
<h3>Description</h3>

<div class="section-text">
<p>Reports often display images in various formats: 
corporate logos, product images, icons, and so on. Popular image formats are 
JPEG for photographs, and GIF, PNG and SVG for computer-generated graphics such 
as logos.</p>
<p>The image item provides an image in one of a number of 
formats. The image can come from a number of sources. The image item can be 
sized to the image (in which case the height and width attributes are ignored), 
or the image can be sized or clipped to fit the item. Images are always scaled 
proportionately.</p>
<p>The image item is similar to the Image report element in 
RDL, the image control in AFC and the picture item in Crystal. Key features 
include:</p>

<ul>
<li>Store the image as part of the report design, obtain the image at run time, or reference the image at view time.</li>

<li>Allow the image to come from a BLOB field in the query.</li>

<li>Associate a hyperlink with the image.</li>

<li>Support line images. This is an image that is repeated to form a line. For example, a slice of an image can repeat to form a custom border along the top or side of a report. Allow repetition across or down.</li>

</ul>
<p>The image element should provide a number of options for 
handling images that are larger or smaller than the size of the element itself:</p>

<ul>
<li>Clip the image to fit the element. Provide options of clipping all four edges so the image remains centered in the element, or clipping the bottom and left edges.</li>

<li>Expand or shrink the element to fit the image size. This is the default, and works well for reports that use the power-assist form of layout (see below.)</li>

<li>Adjust the element size to fit the image.</li>

</ul>
<p>The following table shows which properties are used for 
each image source type.</p>

<table class="section-table">
  <tr>
    <td>Property</td>
    <td>Embedded</td>
    <td>File</td>
    <td>URL</td>
    <td>Computed</td>
  </tr>
  <tr>
    <td>
    Image Name</td>
    <td align="center">X</td>
    <td align="center"></td>
    <td align="center"></td>
    <td align="center"></td>
  </tr>
  <tr>
    <td>
    URI</td>
    <td align="center"></td>
    <td align="center">X</td>
    <td align="center">X</td>
    <td align="center"></td>
  </tr>
  <tr>
    <td>
    Value Expression</td>
    <td align="center"></td>
    <td align="center"></td>
    <td align="center"></td>
    <td align="center">X</td>
  </tr>
  <tr>
    <td>Type Expression</td>
    <td align="center"></td>
    <td align="center"></td>
    <td align="center"></td>
    <td align="center">X</td>
  </tr>
  <tr>
    <td>Size</td>
    <td align="center">X</td>
    <td align="center">X</td>
    <td align="center">X</td>
    <td align="center">X</td>
  </tr>
</table></div>
<h1>Property Detail</h1>

<h2><a name="Property-action">action Property</a></h2>

<p class="section-text">An optional hyperlink for this image.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../structs/Action.html">Action</a> Structure</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Action</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>Provides a hyperlink from this image.</p></p></div>

<hr>
<h2><a name="Property-altText">altText Property</a></h2>

<p class="section-text">An optional text message to display in place of the image in a web browser.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Alternative text</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>An optional text message to display in place of the image 
in a web browser.</p></p></div>
<h3>See Also</h3>

<div class="section-text">
<p>altTextID property</p></div>

<hr>
<h2><a name="Property-altTextID">altTextID Property</a></h2>

<p class="section-text">Resource key for the altText property.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#resourceKey">resourceKey</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Alternative text key</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>Resource key that allows externalizing and localizing the value of the 
altText property.</p>
<p></p></div>
<h3>See Also</h3>

<div class="section-text">
<p>altText property</p></div>

<hr>
<h2><a name="Property-fitToContainer">fitToContainer Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Fit to container</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-helpText">helpText Property</a></h2>

<p class="section-text">An optional help text for the image.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Help text</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>An optional help text for the image. The help text can 
contain HTML formatting and can be externalized. The web viewer shows this as 
&quot;balloon help.&quot;</p></p></div>
<h3>See Also</h3>

<div class="section-text">
<p>helpTextID property</p></div>

<hr>
<h2><a name="Property-helpTextID">helpTextID Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#resourceKey">resourceKey</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Help text key</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-imageName">imageName Property</a></h2>

<p class="section-text">The name of an embedded image if the Source type is Embedded.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#structRef">structRef</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Image name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>The name of an embedded image if the Source type is 
Embedded.</p></p></div>

<hr>
<h2><a name="Property-scale">scale Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#float">float</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Scale</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>1.0</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-size">size Property</a></h2>

<p class="section-text">How to manage the relationship between image and item 
size.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (imageSize)</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Size</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>size-to-image</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>size-to-image</td>
<td>Size to Image</td>
<td>size-to-image</td>
<td></td></tr>
<tr><td>scale-to-item</td>
<td>Scale to Item</td>
<td>scale-to-item</td>
<td></td></tr>
<tr><td>clip</td>
<td>Clip</td>
<td>clip</td>
<td></td></tr>
</tbody></table><br>

<hr>
<h2><a name="Property-source">source Property</a></h2>

<p class="section-text">The kind of image reference.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (imageRefType)</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>Yes</td></tr>
<tr><td>Display Name:</td>
<td>Source</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>none</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>none</td>
<td>No image</td>
<td>none</td>
<td></td></tr>
<tr><td>url</td>
<td>URL</td>
<td>url</td>
<td>image is given by a URL 
    to be evaluated at presentation time.</td></tr>
<tr><td>file</td>
<td>FILE</td>
<td>file</td>
<td>The image is in a file.</td></tr>
<tr><td>expr</td>
<td>Expression</td>
<td>expr</td>
<td>The image is returned 
    by an expression. (Not in the first release.)</td></tr>
<tr><td>embed</td>
<td>Embedded Image</td>
<td>embed</td>
<td>The image is embedded 
    within the design.</td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p><p>The image can be provided in a number of formats. The 
choice here determines which of the other properties that BIRT will consider 
when obtaining the image value.</p><p>The expr option is not available in 
Release 1.0. That is, the image cannot be retrieved from a database in Release 
1.0.</p></p></div>

<hr>
<h2><a name="Property-typeExpr">typeExpr Property</a></h2>

<p class="section-text">An expression that returns the type of the image expressed as a MIME type.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>string</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Type expression</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>An expression that returns the type of the image 
expressed as a MIME type: image/jpeg, image/png, image/gif, etc. If omitted, 
BIRT will attempt to infer the image type from the data in the image itself.</p></p></div>

<hr>
<h2><a name="Property-uri">uri Property</a></h2>

<p class="section-text">The identifier for the image if the type is File or URL.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>string</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>URI</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>The identifier for the image if the type is File or URL. 
The type of image is inferred from the image file content or HTTP response.</p></p></div>

<hr>
<h2><a name="Property-valueExpr">valueExpr Property</a></h2>

<p class="section-text">An expression which returns the image contents.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>blob</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Value expression</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p><p>An expression which returns the image contents.</p></p></div>
<h1>Method Detail</h1>

<h2><a name="Method-onCreate">onCreate Method</a></h2>

<p class="section-text">Script executed when the element is created in the Factory.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onCreate(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Executed when the element is created in the Factory. Called after the item is created, but before 
the item is saved to the report document file. See the scripting spec for additional information 
about this script. Applications should perform visual customization in the on-render script instead.</p></div>

<hr>
<h2><a name="Method-onPageBreak">onPageBreak Method</a></h2>

<p class="section-text"></p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onPageBreak(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>2.1</td></tr>
<tr><td>Context:</td>
<td>presentation</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>


<hr>
<h2><a name="Method-onPrepare">onPrepare Method</a></h2>

<p class="section-text">It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onPrepare(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Context:</td>
<td>startup</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>It is for a script startup phase. No data binding yet. The design of an element can be changed here.</p></div>

<hr>
<h2><a name="Method-onRender">onRender Method</a></h2>

<p class="section-text">Script executed when the element is prepared for rendering in the Presentation engine.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onRender(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>presentation</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Executed when the element is prepared for rendering in the Presentation engine. Changes made to the 
element are written to the target output format, but not saved to the report document file. This is the
preferred place for visual customizations.</p></div>
</body>
</html>
